BBS Toolkit

home *** CD-ROM | disk | FTP | other *** search

/ BBS Toolkit / BBS Toolkit.iso / doors_2 / remind15.zip / REMINDME.DOC < prev next >

Wrap

Text File | 1992-12-26 | 16KB | 363 lines

REMIND ME ! v1.5 by Al Lawrence Sunrise-80 BBS (404) 256-9525 OVERVIEW ________ The REMIND ME! Door allows your callers to enter REMINDERS to themselves. They can be reminded daily, on a specific date, a day of the week, on a paricular date of the month OR on EVEN or ODD days of the month (in essence displaying the Reminder every other day). Reminders are displayed to the caller when they open the Door or automatically if you make it an Auto Login Door. SYSOP can leave reminders to ALL, specific Security levels or to SPECIFIC USERS!!!! NOTE: Most errors will be logged to a file called DFRAME.ERR which is created in the directory you run the door from. INSTALLATION ____________ Installation is fairly easy and straight-forward. The following steps and examples should have you up and running in a very short period of time. It is assumed that you are familiar with setting up DOORS on your system. To this end, only examples of the configuration file and Door batch file are described. 1) Create a directory to hold all REMINDME files 2) Unzip REMINDxx.ZIP into the the above directory 3) Create a configuration file, with a name of your choice, or modify the supplied REMINDME.CFG file. A description follows: ** Location of system file (See Below) SUNRISE-80 BBS Your BBS Name Al Sysop's First name Lawrence Sysop's Last Name |-----------------------------------------------------------------------------| | READ! 1 CommPort \ These 2 lines are required | | READ! 1 Node # / ONLY for GTUSER.BBS | |-----------------------------------------------------------------------------| 00000000 Registration Number 2 1 = DO NOT Display ADOPT-A-DOOR Message 2 = Display ADOPT-A-DOOR message 2 Keyboard timeout value in Minutes N Y = Use European Date Format (DDMMYY) N = Use Regular Date Format (MMDDYY) 365 Maximum # of days caller can enter in response to the number of warning days. This number will be used to determine how many days prior to the due to start displaying the Reminder. (0-365). 0 = No warning days 365 Maximum # of days caller can enter in in response to how long the reminder will remain active (1-365) 0 Additional Security level that will be allowed to leave Reminders as if they were the Sysop (Co-Sysop as an example) Note: They will NOT be able to Delete or Modify or Review messages they entered to a Specific caller or to All Callers. Y Y = Do check if caller is ANSI capable N = DoNot check if caller is ANSI capable NONE Drive\path\filename of the file you want displayed when returning from an AUTO-LOGIN to the BBS. NONE Drive\Path\Filename of the file you want displayed when manually exiting the Door using the Exit option from the Main Menu. ** = Replace with ONE of the following: C:\BBS\PCBOARD.SYS <- For PCBoard systems using PCBOARD.SYS only C:\BBS\CALLINFO.BBS <- For Wildcat! systems (prior to v3.0) C:\BBS\USERINFO.DAT <- For Wildcat! systems using v3.x (Note:DOOR.SYS must be in SAME directory) C:\BBS\DOOR.SYS <- For ANY systems that support DOOR.SYS C:\BBS\DORINFOx.DEF <- For ANY systems that support DORINFOx.DEF C:\BBS\SFDOORS.DAT <- For Spitfire systems. c:\bbs\TRIBBS.SYS <- For TriBBS systems. C:\BBS\CHAIN.TXT <- For WWIV systems C:\BBS\GTUSER.BBS <- For GT Power * if using this option you must put the ComPort # on line 5 and the Node # on line 6 of the configuration file # = Requires registration to change to a different value. NOTE: There are NO Blank Lines in the Config File!! 4) Create a batch file or modify the REMINDME file supplied. A description of this file follows: ECHO off cd\BBS\DOORS\REMINDME Location of REMINDME files REMINDME REMINDME.CFG EXE filename and CFG filename (Name used in creating file in #3 above) CD\BBS BOARD 5) When running in more than one node, be sure to supply a different configuration name for each node (your choice of name). 6) If running with Fossil-based multi-port boards add /FD to the line containing the CFG name as follows: REMINDME REMINDME.CFG /FD TRASHCAN File ------------- If you wish to trap any words that you do not want your users to see, such as foul language, etc, then you create an ASCII file with the word or words. Each word must appear on a separate line, up to a maximum of 100. The name of the file must be TRASHCAN and must reside in the same directory as the REMINDME.EXE file. The program will check ALL description lines against the list. If a match is found the offending word(s) will be changed to asteriks (*). AUTO LOGIN OPTION (Registered Version Only) ------------------------------------------- Should you want to take your callers to the REMIND ME Door automatically at logon I would suggest that you set up 2 batch files. One batch file would take the caller to the Door if they selected it off your Door Menu. They would be presented with any Reminders that have come due AND they will be able to use all the functions of the Door. See #4 above for example. The second batch file would take your caller to the Door, present the caller with any Reminders that have come due and immediately return to the BBS. REMIND ME will display a file you have defined in the CFG, while the system is returning to the BBS. All that would be required would be to create another batch file as in #4 above, give it another name (I use REMLOGIN, but you do what you have to depending on your BBS software) and ADD $BYPASS$ to the END of the Command line. Example: REMINDME REMINDME.CFG $BYPASS$ Note: $BYPASS$ must be the last parameter on the line Everything else in the batch file is the same as #4 above NON-STANDARD COM SUPPORT ________________________ Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ number after the configuration filename. Let's assume your Door is called FOOBAR and you want to use COM1 and IRQ5. The command line passed to your Door would be: FOOBAR FOOBAR.CFG /5 The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is normally used with COM1. No /x parameter is needed for the standard IRQ's. As an alternative, you may use an environmental variable on the command line. To use the variable (following the example above), place a SET IRQ=5 in the batch file used to bring up your BBS (you would need a different IRQ number for each node). The command line would now look like this: FOOBAR FOOBAR.CFG /%IRQ% This, in combination with the use of the environmental variables described in the MULTI-NODE SETUP section will allow you to use one batch file and one config file to run this door on all nodes. MULTI-NODE SETUP ________________ All Sunrise Doors are Multi-Node capable. Each node must have the ability to access a configuration file which will have its own system file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first line. There are 2 ways to accomplish this: (1) Create a separate configuration file for each node. The only difference between each file would be the location of the system file for that particular node. For example, on my system there are 2 nodes and the first line of the config files would look like this: NODE1: H:\PCB1\DOOR.SYS NODE2: H:\PCB2\DOOR.SYS Thus, if you have a 4 node BBS, you will need 4 configuration files. (2) Use ONE configuration file for ALL nodes. This Door will recognize the following PCBoard environmental variables: PCBDIR (Directory containing the System file) PCBDRIVE (Drive containing the System file) Thus, the first line of the SINGLE configuration file, for this Door would look like this: %PCBDRIVE%%PCBDIR%\DOOR.SYS NOTE: This option, as described, assumes that you are running PCBoard 14.5a software. The environmental variables are automatically created by the software for each node. HOWEVER, if you are running other BBS software you should be able to set the variables EXACTLY as described below, for EACH node (more than likely in each batch file you use to bring up EACH node): PCBDRIVE=C: ^^^^^^^^^ PCBDIR=\NODE2 ^^^^^^^^ Info with a carat (^) under it, MUST be typed as is. The rest depends on your naming conventions. This, in combination with the use of the optional environmental variable described in the NON-STANDARD COM SUPPORT section, will allow you to use one batch file and one config file to run this door on all nodes. ADOPT-A-DOOR ____________ Having been a Sysop for a number of years, I have had my share of problems and frustrations getting financial support for my board's upkeep. A fellow Sysop left a message on my board, not long ago, about a concept that was being used by several boards around the country. The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It would be the same as sending in a donation, only this way it is earmarked for registering a particular door. In a way, the user feels he/she is "getting something in return". As a Door author I have decided to build this concept into each of my Door programs. The concept replaces the usual message "tell the Sysop to register this Door" we find in most doors. If the Door is unregisterd then a message appears on the opening screen to that effect. After finishing or suspending a game, a message screen is displayed about the ADOPT-A-DOOR concept. The message also tells the caller to contact the Sysop to find out if there is any further details to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online time, etc to callers that ADOPT-A-DOOR. If the Door has been registered, either by the Sysop or other callers, the names of those contributors will be displayed in the closing screen. NOTE: If you want to display the names of the callers that contributed to registering the Door, you must create an ASCII file called ADOPT.SYS. You create it with an Editor or Word Processor. Enter the name(s) of the contributors (one on each line, maximum of 5 entries, each a maximum of 30 characters long). This file must be saved, in ASCII format, and placed in the Door directory. LEGALITIES __________ THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS" WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF OR BREACH OF ANY WARRANTY. DISTRIBUTION ____________ You may make this file available for downloading from your BBS or you may upload it to any BBS of your choice, provided that you do not make any changes to the contents of the archive (ZIP file). The archive and its individual contents may not be used by any service that charges any money whatsoever, without the written permission of the author. REGISTRATION ____________ Registration and the subsequent insertion of the registration number into your configuation file, allows for the display of your BBS name on the opening and closing screen as well as the reduction of a delay built into the opening screen display along with the ability to change certain values in the configuration file. To register your copy of REMINDME, please fill out the registration form (REGISTER.FRM) and mail it along with the appropriate registration fee to the name and address on the form. Be sure to use the proper upper/lower case when filling in your name and BBS name, as they MUST match the way you entered them in the configuration file. ^^^^ Based upon information supplied on the registration form, I will pre- register you on my BBS. You will then be able to call SUNRISE-80 and pick up your registration number. MISC ____ The latest version of REMIND ME! and other fine SUNRISE DOOR programs are always available for download from SUNRISE-80 BBS. Remember, should you have any problems, questions or suggestions, be sure to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors, PCBHints, SYSops) or on SMARTNET (SN_Sysops) or FIDO 1:133/410.